docs: fix description and add missing spaces by Planeshifter · Pull Request #14202 · stdlib-js/stdlib

Planeshifter · 2026-08-12T13:28:10Z

Description

What is the purpose of this pull request?

This pull request:

propagates fixes merged to develop between 2026-08-11 and 2026-08-12 to sibling packages with the same defects.

Doubled period in C header doc comment (source: 10f021c)

Removes a doubled sentence-ending period from the C header doc comment in @stdlib/constants/float32/eps (include/stdlib/constants/float32/eps.h, line 23), which read "...floating-point number.." — the float64 sibling header already uses a single period. Found via a repo-wide scan for the same defect fixed in 10f021c, which corrected an identical doubled period in the @stdlib/stats/base/ndarray/dnanmeanpn header. No functional change; doc comment only.

JSDoc example indentation in TypeScript declaration files (sources: cb9723a, 7026843)

Fixes JSDoc example indentation in TypeScript declaration files, propagating the correction from cb9723a and 7026843 (merged to develop 2026-08-11), which fixed object-literal option keys indented four spaces after the comment asterisk instead of the conventional five (e.g. * 'dtype': 'generic' → * 'dtype': 'generic'). A repo-wide scan turned up the same defect in seven remaining declaration files; this corrects all 57 lines. The @stdlib/ndarray namespace declaration is generated by _tools/scripts/create_namespace_types.js from sub-package declarations, and its one affected line derives from ndarray/broadcast-scalar-like, fixed in this same commit, so the manual edit matches what the next regeneration will emit. Two remaining instances, in blas/ext/base/ndarray/ccopy-within and zcopy-within, are intentionally excluded — already fixed by open PR #14201.

@stdlib/ndarray (namespace declarations, 1 line)
@stdlib/ndarray/find (1 line)
@stdlib/ndarray/find-last (1 line)
@stdlib/ndarray/broadcast-scalar-like (26 lines)
@stdlib/ndarray/from-scalar-like (24 lines)
@stdlib/string/first (2 lines)
@stdlib/string/last (2 lines)

Related Issues

Does this pull request have any related issues?

No related issues.

Questions

Any questions for reviewers of this pull request?

No.

Other

Validation performed:

Pattern signatures were scanned repo-wide (rg over *.h for doubled periods; over **/docs/types/index.d.ts for four-space option-key indentation, where 761 files use the five-space form).
Each candidate site was independently verified by two full-file review passes, a verbatim-applicability pass, and a style-consistency pass against docs/style-guides and sibling packages fixed by the source commits.
Deliberately excluded: blas/ext/base/ndarray/ccopy-within/zcopy-within (covered by open PR style: add missing spaces #14201); four-space @example function-body lines in ndarray/docs/types/index.d.ts deriving from ndarray/count-if (different construct — fix belongs in count-if at source); ..-terminated inline // comments in .js files (different context from doc comments).

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

Yes
No

If you answered "yes" above, how did you use AI assistance?

Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding

Disclosure

This PR was authored by Claude Code as part of an automated routine which propagates recently merged fixes to sibling packages. Candidate sites were located by pattern search and validated by independent review passes against the source commits and repository conventions.

@stdlib-js/reviewers

Generated by Claude Code

Propagates fix from 10f021c ("docs: fix example and description") to a sibling site with the same doubled sentence-ending period in a C header documentation comment. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JPpNMgm5XwGLrxHLQK1oVg

Propagates fixes from cb9723a ("docs: update examples") and 7026843 ("style: add missing spaces") to the remaining TypeScript declaration files indenting object-literal option keys in JSDoc examples with four spaces instead of five. Affected packages: `ndarray`, `ndarray/find`, `ndarray/find-last`, `ndarray/broadcast-scalar-like`, `ndarray/from-scalar-like`, `string/first`, and `string/last`. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JPpNMgm5XwGLrxHLQK1oVg

stdlib-bot · 2026-08-12T13:30:46Z

Coverage Report

Package	Statements	Branches	Functions	Lines
constants/float32/eps	$\\color{green}61/61$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}0/0$ $\\color{green}+100.00\\%$	$\\color{green}61/61$ $\\color{green}+100.00\\%$
ndarray	$\\color{red}209388/390735$ $\\color{green}+53.59\\%$	$\\color{red}2418/2463$ $\\color{green}+98.17\\%$	$\\color{red}50/2040$ $\\color{green}+2.45\\%$	$\\color{red}209388/390735$ $\\color{green}+53.59\\%$
ndarray/broadcast-scalar-like	$\\color{green}195/195$ $\\color{green}+100.00\\%$	$\\color{green}29/29$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}195/195$ $\\color{green}+100.00\\%$
ndarray/find	$\\color{red}593/597$ $\\color{green}+99.33\\%$	$\\color{red}73/77$ $\\color{green}+94.81\\%$	$\\color{green}4/4$ $\\color{green}+100.00\\%$	$\\color{red}593/597$ $\\color{green}+99.33\\%$
ndarray/find-last	$\\color{green}416/416$ $\\color{green}+100.00\\%$	$\\color{green}44/44$ $\\color{green}+100.00\\%$	$\\color{green}5/5$ $\\color{green}+100.00\\%$	$\\color{green}416/416$ $\\color{green}+100.00\\%$
ndarray/from-scalar-like	$\\color{green}190/190$ $\\color{green}+100.00\\%$	$\\color{green}23/23$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}190/190$ $\\color{green}+100.00\\%$
string/first	$\\color{green}177/177$ $\\color{green}+100.00\\%$	$\\color{green}20/20$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}177/177$ $\\color{green}+100.00\\%$
string/last	$\\color{green}177/177$ $\\color{green}+100.00\\%$	$\\color{green}20/20$ $\\color{green}+100.00\\%$	$\\color{green}1/1$ $\\color{green}+100.00\\%$	$\\color{green}177/177$ $\\color{green}+100.00\\%$

The above coverage report was generated for the changes in this PR.

claude added 2 commits August 12, 2026 13:25

Planeshifter marked this pull request as ready for review August 12, 2026 14:04

Planeshifter requested a review from a team August 12, 2026 14:04

stdlib-bot added the Needs Review A pull request which needs code review. label Aug 12, 2026

Planeshifter requested a review from kgryte August 12, 2026 14:04

kgryte approved these changes Aug 12, 2026

View reviewed changes

kgryte changed the title ~~docs: propagate doc fixes to ndarray, string, and constants~~ docs: fix description and add missing spaces Aug 12, 2026

kgryte merged commit a0ddbae into develop Aug 12, 2026
35 checks passed

kgryte deleted the claude/ecstatic-heisenberg-f4jjvw branch August 12, 2026 23:09

kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Aug 12, 2026

Navigation Menu

Uh oh!

Uh oh!

docs: fix description and add missing spaces - #14202

docs: fix description and add missing spaces#14202
kgryte merged 2 commits into
developfrom
claude/ecstatic-heisenberg-f4jjvw

Planeshifter commented Aug 12, 2026

Uh oh!

stdlib-bot commented Aug 12, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Uh oh!

Conversation

Planeshifter commented Aug 12, 2026

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

stdlib-bot commented Aug 12, 2026

Coverage Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants